ThinkPHP5


think\console\input\Definition
library\think\console\input\Definition.php at line 14

Class Definition

Definition

public class Definition


Constructor Summary
void

__construct(array definition)

构造方法

Method Summary
void

setDefinition(array definition)

设置指令的定义

void

setArguments(Argument arguments)

设置参数

void

addArguments(Argument arguments)

添加参数

void

addArgument(Argument argument)

添加一个参数

Argument

getArgument(string|int name)

根据名称或者位置获取参数

bool

hasArgument(string|int name)

根据名称或位置检查是否具有某个参数

Argument[]

getArguments()

获取所有的参数

int

getArgumentCount()

获取参数数量

int

getArgumentRequiredCount()

获取必填的参数的数量

array

getArgumentDefaults()

获取参数默认值

void

setOptions(Option options)

设置选项

void

addOptions(Option options)

添加选项

void

addOption(Option option)

添加一个选项

Option

getOption(string name)

根据名称获取选项

bool

hasOption(string name)

根据名称检查是否有这个选项

Option[]

getOptions()

获取所有选项

bool

hasShortcut(string name)

根据名称检查某个选项是否有短名称

Option

getOptionForShortcut(string shortcut)

根据短名称获取选项

array

getOptionDefaults()

获取所有选项的默认值

string

getSynopsis(bool short)

获取该指令的介绍

Constructor Detail

library\think\console\input\Definition.php at line 37

__construct

public void __construct(array definition)

构造方法

Api.

Method Detail

library\think\console\input\Definition.php at line 46

setDefinition

public void setDefinition(array definition)

设置指令的定义

Parameters:
definition - 定义的数组

library\think\console\input\Definition.php at line 66

setArguments

public void setArguments(Argument arguments)

设置参数

Parameters:
arguments - 参数数组

library\think\console\input\Definition.php at line 80

addArguments

public void addArguments(Argument arguments)

添加参数

Parameters:
arguments - 参数数组
Api.

library\think\console\input\Definition.php at line 94

addArgument

public void addArgument(Argument argument)

添加一个参数

Parameters:
argument - 参数
Throws:
\LogicException

library\think\console\input\Definition.php at line 127

getArgument

public Argument getArgument(string|int name)

根据名称或者位置获取参数

Parameters:
name - 参数名或者位置
Returns:
参数
Throws:
\InvalidArgumentException

library\think\console\input\Definition.php at line 144

hasArgument

public bool hasArgument(string|int name)

根据名称或位置检查是否具有某个参数

Parameters:
name - 参数名或者位置
Api.

library\think\console\input\Definition.php at line 155

getArguments

public Argument[] getArguments()

获取所有的参数

Returns:
参数数组

library\think\console\input\Definition.php at line 164

getArgumentCount

public int getArgumentCount()

获取参数数量


library\think\console\input\Definition.php at line 173

getArgumentRequiredCount

public int getArgumentRequiredCount()

获取必填的参数的数量


library\think\console\input\Definition.php at line 182

getArgumentDefaults

public array getArgumentDefaults()

获取参数默认值


library\think\console\input\Definition.php at line 196

setOptions

public void setOptions(Option options)

设置选项

Parameters:
options - 选项数组

library\think\console\input\Definition.php at line 208

addOptions

public void addOptions(Option options)

添加选项

Parameters:
options - 选项数组
Api.

library\think\console\input\Definition.php at line 221

addOption

public void addOption(Option option)

添加一个选项

Parameters:
option - 选项
Throws:
\LogicException
Api.

library\think\console\input\Definition.php at line 252

getOption

public Option getOption(string name)

根据名称获取选项

Parameters:
name - 选项名
Throws:
\InvalidArgumentException
Api.

library\think\console\input\Definition.php at line 267

hasOption

public bool hasOption(string name)

根据名称检查是否有这个选项

Parameters:
name - 选项名
Api.

library\think\console\input\Definition.php at line 277

getOptions

public Option[] getOptions()

获取所有选项

Api.

library\think\console\input\Definition.php at line 287

hasShortcut

public bool hasShortcut(string name)

根据名称检查某个选项是否有短名称

Parameters:
name - 短名称

library\think\console\input\Definition.php at line 297

getOptionForShortcut

public Option getOptionForShortcut(string shortcut)

根据短名称获取选项

Parameters:
shortcut - 短名称

library\think\console\input\Definition.php at line 306

getOptionDefaults

public array getOptionDefaults()

获取所有选项的默认值


library\think\console\input\Definition.php at line 336

getSynopsis

public string getSynopsis(bool short)

获取该指令的介绍

Parameters:
short - 是否简洁介绍

ThinkPHP5